<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>reporting</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/uprgae-console/">UPR-GAE console</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;reporting
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="reporting-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="reporting-module.html">Module reporting</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/python</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Copyright (C) 2007 Google Inc.</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Licensed under the Apache License, Version 2.0 (the "License")</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># you may not use this file except in compliance with the License.</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># You may obtain a copy of the License at</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#     http://www.apache.org/licenses/LICENSE-2.0</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Unless required by applicable law or agreed to in writing, software</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># distributed under the License is distributed on an "AS IS" BASIS,</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># See the License for the specific language governing permissions and</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># limitations under the License.</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-docstring">"""This module implements a client for the Google Apps Reporting API.</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-docstring">The Google Apps Reporting API allows domain administrators the ability to</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-docstring">query user behaviour and resource usage for a given time frame.</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-docstring">The Google Apps Reporting API reference document is at:</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring">http://code.google.com/apis/apps/reporting/google_apps_reporting_api.html</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring">  ReportRequest:   Encapsulates attribute of a Reporting API request.</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring">  Error:           Base error class.</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-docstring">  ReportError:     Error while executing report.</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring">  ConnectionError: Error during HTTPS connection to a URL.</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-docstring">  ReportRunner:    Contains the web service calls to run a report.</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring">  main():          Run a report with command-line arguments.</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">getopt</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">time</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urllib</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urllib2</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"> </tt>
<a name="ReportRequest"></a><div id="ReportRequest-def"><a name="L43"></a><tt class="py-lineno"> 43</tt> <a class="py-toggle" href="#" id="ReportRequest-toggle" onclick="return toggle('ReportRequest');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="reporting.ReportRequest-class.html">ReportRequest</a><tt class="py-op">:</tt> </tt>
</div><div id="ReportRequest-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ReportRequest-expanded"><a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line">  <tt class="py-docstring">"""This class encapsulates the attributes of a Reporting API request."""</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-comment">#edwood.ocasio: page tag added to template</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># '  &lt;page&gt;%(page)s&lt;/page&gt;\n'</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># as seen in http://code.google.com/apis/apps/reporting/google_apps_reporting_api.html#google_apps_tag_page</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt id="link-0" class="py-name" targets="Variable reporting.ReportRequest._REQUEST_TEMPLATE=reporting.ReportRequest-class.html#_REQUEST_TEMPLATE"><a title="reporting.ReportRequest._REQUEST_TEMPLATE" class="py-name" href="#" onclick="return doclink('link-0', '_REQUEST_TEMPLATE', 'link-0');">_REQUEST_TEMPLATE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'&lt;?xml version="1.0" encoding="UTF-8"?&gt;\n'</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line">      <tt class="py-string">'&lt;rest xmlns="google:accounts:rest:protocol"\n'</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line">      <tt class="py-string">'    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"&gt;\n'</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line">      <tt class="py-string">'  &lt;type&gt;%(type)s&lt;/type&gt;\n'</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line">      <tt class="py-string">'  &lt;token&gt;%(token)s&lt;/token&gt;\n'</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line">      <tt class="py-string">'  &lt;domain&gt;%(domain)s&lt;/domain&gt;\n'</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line">      <tt class="py-string">'  &lt;date&gt;%(date)s&lt;/date&gt;\n'</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line">      <tt class="py-string">'  &lt;page&gt;%(page)s&lt;/page&gt;\n'</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line">      <tt class="py-string">'  &lt;reportType&gt;%(report_type)s&lt;/reportType&gt;\n'</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line">      <tt class="py-string">'  &lt;reportName&gt;%(report_name)s&lt;/reportName&gt;\n'</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line">      <tt class="py-string">'&lt;/rest&gt;\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"> </tt>
<a name="ReportRequest.__init__"></a><div id="ReportRequest.__init__-def"><a name="L63"></a><tt class="py-lineno"> 63</tt> <a class="py-toggle" href="#" id="ReportRequest.__init__-toggle" onclick="return toggle('ReportRequest.__init__');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportRequest-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportRequest.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportRequest.__init__-expanded"><a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line">    <tt class="py-docstring">"""Initializes the report request with default values."""</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">type</tt> <tt class="py-op">=</tt> <tt class="py-string">'Report'</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Variable uprgae.domain=uprgae-module.html#domain"><a title="uprgae.domain" class="py-name" href="#" onclick="return doclink('link-1', 'domain', 'link-1');">domain</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">date</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">report_type</tt> <tt class="py-op">=</tt> <tt class="py-string">'daily'</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">report_name</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-comment">#edwood.ocasio: added page attribute to class</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">page</tt><tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"><tt class="py-comment">###################################</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="ReportRequest.ToXml"></a><div id="ReportRequest.ToXml-def"><a name="L77"></a><tt class="py-lineno"> 77</tt> <a class="py-toggle" href="#" id="ReportRequest.ToXml-toggle" onclick="return toggle('ReportRequest.ToXml');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportRequest-class.html#ToXml">ToXml</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportRequest.ToXml-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportRequest.ToXml-expanded"><a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line">    <tt class="py-docstring">"""Return the XML request for the Reporting API.</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring">    Returns:</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">      Reporting API XML request string.</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt id="link-2" class="py-name" targets="Class reporting.ReportRequest=reporting.ReportRequest-class.html"><a title="reporting.ReportRequest" class="py-name" href="#" onclick="return doclink('link-2', 'ReportRequest', 'link-2');">ReportRequest</a></tt><tt class="py-op">.</tt><tt id="link-3" class="py-name"><a title="reporting.ReportRequest._REQUEST_TEMPLATE" class="py-name" href="#" onclick="return doclink('link-3', '_REQUEST_TEMPLATE', 'link-0');">_REQUEST_TEMPLATE</a></tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> </tt>
</div></div><a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line"> </tt>
<a name="Error"></a><div id="Error-def"><a name="L87"></a><tt class="py-lineno"> 87</tt> <a class="py-toggle" href="#" id="Error-toggle" onclick="return toggle('Error');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="reporting.Error-class.html">Error</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Error-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Error-expanded"><a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line">  <tt class="py-docstring">"""Base error class."""</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line">  <tt class="py-keyword">pass</tt> </tt>
</div><a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line"> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line"> </tt>
<a name="LoginError"></a><div id="LoginError-def"><a name="L94"></a><tt class="py-lineno"> 94</tt> <a class="py-toggle" href="#" id="LoginError-toggle" onclick="return toggle('LoginError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="reporting.LoginError-class.html">LoginError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LoginError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="LoginError-expanded"><a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line">  <tt class="py-docstring">"""Unable to log in to authentication service."""</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line">  <tt class="py-keyword">pass</tt> </tt>
</div><a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"> </tt>
<a name="ReportError"></a><div id="ReportError-def"><a name="L100"></a><tt class="py-lineno">100</tt> <a class="py-toggle" href="#" id="ReportError-toggle" onclick="return toggle('ReportError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="reporting.ReportError-class.html">ReportError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ReportError-expanded"><a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line">  <tt class="py-docstring">"""Report execution error class."""</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line"> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line">  <tt id="link-4" class="py-name" targets="Variable reporting.ReportError._ERROR_TEMPLATE=reporting.ReportError-class.html#_ERROR_TEMPLATE"><a title="reporting.ReportError._ERROR_TEMPLATE" class="py-name" href="#" onclick="return doclink('link-4', '_ERROR_TEMPLATE', 'link-4');">_ERROR_TEMPLATE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'Error executing report:\n'</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line">                     <tt class="py-string">'  status=%(status)s\n'</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line">                     <tt class="py-string">'  reason=%(reason)s\n'</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line">                     <tt class="py-string">'  extended_message=%(extended_message)s\n'</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line">                     <tt class="py-string">'  result=%(result)s\n'</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line">                     <tt class="py-string">'  type=%(type)s\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line">  <tt id="link-5" class="py-name" targets="Variable reporting.ReportError._STATUS_PATTERN=reporting.ReportError-class.html#_STATUS_PATTERN"><a title="reporting.ReportError._STATUS_PATTERN" class="py-name" href="#" onclick="return doclink('link-5', '_STATUS_PATTERN', 'link-5');">_STATUS_PATTERN</a></tt>  <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'status&gt;(.*?)&lt;'</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">DOTALL</tt><tt class="py-op">)</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line">  <tt id="link-6" class="py-name" targets="Variable reporting.ReportError._REASON_PATTERN=reporting.ReportError-class.html#_REASON_PATTERN"><a title="reporting.ReportError._REASON_PATTERN" class="py-name" href="#" onclick="return doclink('link-6', '_REASON_PATTERN', 'link-6');">_REASON_PATTERN</a></tt>  <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'reason&gt;(.*?)&lt;'</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">DOTALL</tt><tt class="py-op">)</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line">  <tt id="link-7" class="py-name" targets="Variable reporting.ReportError._EXTENDED_MESSAGE_PATTERN=reporting.ReportError-class.html#_EXTENDED_MESSAGE_PATTERN"><a title="reporting.ReportError._EXTENDED_MESSAGE_PATTERN" class="py-name" href="#" onclick="return doclink('link-7', '_EXTENDED_MESSAGE_PATTERN', 'link-7');">_EXTENDED_MESSAGE_PATTERN</a></tt>  <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'extendedMessage&gt;(.*?)&lt;'</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">DOTALL</tt><tt class="py-op">)</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line">  <tt id="link-8" class="py-name" targets="Variable reporting.ReportError._RESULT_PATTERN=reporting.ReportError-class.html#_RESULT_PATTERN"><a title="reporting.ReportError._RESULT_PATTERN" class="py-name" href="#" onclick="return doclink('link-8', '_RESULT_PATTERN', 'link-8');">_RESULT_PATTERN</a></tt>  <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'result&gt;(.*?)&lt;'</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">DOTALL</tt><tt class="py-op">)</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line">  <tt id="link-9" class="py-name" targets="Variable reporting.ReportError._TYPE_PATTERN=reporting.ReportError-class.html#_TYPE_PATTERN"><a title="reporting.ReportError._TYPE_PATTERN" class="py-name" href="#" onclick="return doclink('link-9', '_TYPE_PATTERN', 'link-9');">_TYPE_PATTERN</a></tt>  <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'type&gt;(.*?)&lt;'</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">DOTALL</tt><tt class="py-op">)</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"> </tt>
<a name="ReportError.__init__"></a><div id="ReportError.__init__-def"><a name="L116"></a><tt class="py-lineno">116</tt> <a class="py-toggle" href="#" id="ReportError.__init__-toggle" onclick="return toggle('ReportError.__init__');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportError-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportError.__init__-expanded"><a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line">    <tt class="py-docstring">"""Construct a report execution error."""</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line">    <tt id="link-10" class="py-name" targets="Class reporting.Error=reporting.Error-class.html"><a title="reporting.Error" class="py-name" href="#" onclick="return doclink('link-10', 'Error', 'link-10');">Error</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Method reporting.ConnectionError.__init__()=reporting.ConnectionError-class.html#__init__,Method reporting.ReportError.__init__()=reporting.ReportError-class.html#__init__,Method reporting.ReportRequest.__init__()=reporting.ReportRequest-class.html#__init__,Method reporting.ReportRunner.__init__()=reporting.ReportRunner-class.html#__init__"><a title="reporting.ConnectionError.__init__
reporting.ReportError.__init__
reporting.ReportRequest.__init__
reporting.ReportRunner.__init__" class="py-name" href="#" onclick="return doclink('link-11', '__init__', 'link-11');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-string">'Error executing report'</tt><tt class="py-op">)</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">extended_message</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">type</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"> </tt>
<a name="ReportError.FromXml"></a><div id="ReportError.FromXml-def"><a name="L126"></a><tt class="py-lineno">126</tt> <a class="py-toggle" href="#" id="ReportError.FromXml-toggle" onclick="return toggle('ReportError.FromXml');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportError-class.html#FromXml">FromXml</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">xml</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportError.FromXml-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportError.FromXml-expanded"><a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line">    <tt class="py-docstring">"""Unmarshall an error from a Reporting API XML rstring.</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line"><tt class="py-docstring">    Args:</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line"><tt class="py-docstring">      xml: Reporting API XML response string.</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line">    <tt class="py-name">match</tt> <tt class="py-op">=</tt> <tt id="link-12" class="py-name" targets="Class reporting.ReportError=reporting.ReportError-class.html"><a title="reporting.ReportError" class="py-name" href="#" onclick="return doclink('link-12', 'ReportError', 'link-12');">ReportError</a></tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="reporting.ReportError._STATUS_PATTERN" class="py-name" href="#" onclick="return doclink('link-13', '_STATUS_PATTERN', 'link-5');">_STATUS_PATTERN</a></tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Function uprgae.search()=uprgae-module.html#search"><a title="uprgae.search" class="py-name" href="#" onclick="return doclink('link-14', 'search', 'link-14');">search</a></tt><tt class="py-op">(</tt><tt class="py-name">xml</tt><tt class="py-op">)</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">match</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-op">=</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line">    <tt class="py-name">match</tt> <tt class="py-op">=</tt> <tt id="link-15" class="py-name"><a title="reporting.ReportError" class="py-name" href="#" onclick="return doclink('link-15', 'ReportError', 'link-12');">ReportError</a></tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="reporting.ReportError._REASON_PATTERN" class="py-name" href="#" onclick="return doclink('link-16', '_REASON_PATTERN', 'link-6');">_REASON_PATTERN</a></tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="uprgae.search" class="py-name" href="#" onclick="return doclink('link-17', 'search', 'link-14');">search</a></tt><tt class="py-op">(</tt><tt class="py-name">xml</tt><tt class="py-op">)</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">match</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line">    <tt class="py-name">match</tt> <tt class="py-op">=</tt> <tt id="link-18" class="py-name"><a title="reporting.ReportError" class="py-name" href="#" onclick="return doclink('link-18', 'ReportError', 'link-12');">ReportError</a></tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="reporting.ReportError._EXTENDED_MESSAGE_PATTERN" class="py-name" href="#" onclick="return doclink('link-19', '_EXTENDED_MESSAGE_PATTERN', 'link-7');">_EXTENDED_MESSAGE_PATTERN</a></tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="uprgae.search" class="py-name" href="#" onclick="return doclink('link-20', 'search', 'link-14');">search</a></tt><tt class="py-op">(</tt><tt class="py-name">xml</tt><tt class="py-op">)</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">match</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">extended_message</tt> <tt class="py-op">=</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line">    <tt class="py-name">match</tt> <tt class="py-op">=</tt> <tt id="link-21" class="py-name"><a title="reporting.ReportError" class="py-name" href="#" onclick="return doclink('link-21', 'ReportError', 'link-12');">ReportError</a></tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="reporting.ReportError._RESULT_PATTERN" class="py-name" href="#" onclick="return doclink('link-22', '_RESULT_PATTERN', 'link-8');">_RESULT_PATTERN</a></tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="uprgae.search" class="py-name" href="#" onclick="return doclink('link-23', 'search', 'link-14');">search</a></tt><tt class="py-op">(</tt><tt class="py-name">xml</tt><tt class="py-op">)</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">match</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line">    <tt class="py-name">match</tt> <tt class="py-op">=</tt> <tt id="link-24" class="py-name"><a title="reporting.ReportError" class="py-name" href="#" onclick="return doclink('link-24', 'ReportError', 'link-12');">ReportError</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="reporting.ReportError._TYPE_PATTERN" class="py-name" href="#" onclick="return doclink('link-25', '_TYPE_PATTERN', 'link-9');">_TYPE_PATTERN</a></tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="uprgae.search" class="py-name" href="#" onclick="return doclink('link-26', 'search', 'link-14');">search</a></tt><tt class="py-op">(</tt><tt class="py-name">xml</tt><tt class="py-op">)</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">match</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">type</tt> <tt class="py-op">=</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
</div><a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"> </tt>
<a name="ReportError.__str__"></a><div id="ReportError.__str__-def"><a name="L143"></a><tt class="py-lineno">143</tt> <a class="py-toggle" href="#" id="ReportError.__str__-toggle" onclick="return toggle('ReportError.__str__');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportError-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportError.__str__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportError.__str__-expanded"><a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line">    <tt class="py-docstring">"""Override normal string representation with one which includes all the</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-docstring">    attributes of a report error.</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt id="link-27" class="py-name"><a title="reporting.ReportError" class="py-name" href="#" onclick="return doclink('link-27', 'ReportError', 'link-12');">ReportError</a></tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="reporting.ReportError._ERROR_TEMPLATE" class="py-name" href="#" onclick="return doclink('link-28', '_ERROR_TEMPLATE', 'link-4');">_ERROR_TEMPLATE</a></tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> </tt>
</div></div><a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line"> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line"> </tt>
<a name="ConnectionError"></a><div id="ConnectionError-def"><a name="L150"></a><tt class="py-lineno">150</tt> <a class="py-toggle" href="#" id="ConnectionError-toggle" onclick="return toggle('ConnectionError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="reporting.ConnectionError-class.html">ConnectionError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ConnectionError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ConnectionError-expanded"><a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line"> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line">  <tt class="py-docstring">"""URL connection error class."""</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line"> </tt>
<a name="ConnectionError.__init__"></a><div id="ConnectionError.__init__-def"><a name="L154"></a><tt class="py-lineno">154</tt> <a class="py-toggle" href="#" id="ConnectionError.__init__-toggle" onclick="return toggle('ConnectionError.__init__');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ConnectionError-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ConnectionError.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ConnectionError.__init__-expanded"><a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line">    <tt class="py-docstring">"""Initializes the Error with a connection specific error message."""</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line"> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line">    <tt id="link-29" class="py-name"><a title="reporting.Error" class="py-name" href="#" onclick="return doclink('link-29', 'Error', 'link-10');">Error</a></tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="reporting.ConnectionError.__init__
reporting.ReportError.__init__
reporting.ReportRequest.__init__
reporting.ReportRunner.__init__" class="py-name" href="#" onclick="return doclink('link-30', '__init__', 'link-11');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-string">'URL connection error:\n'</tt> <tt class="py-op">+</tt> <tt class="py-name">message</tt> <tt class="py-op">+</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line">                   <tt class="py-string">'\nwhile attempting to connect to: '</tt> <tt class="py-op">+</tt> <tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line"> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line"> </tt>
<a name="ReportRunner"></a><div id="ReportRunner-def"><a name="L161"></a><tt class="py-lineno">161</tt> <a class="py-toggle" href="#" id="ReportRunner-toggle" onclick="return toggle('ReportRunner');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="reporting.ReportRunner-class.html">ReportRunner</a><tt class="py-op">:</tt> </tt>
</div><div id="ReportRunner-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ReportRunner-expanded"><a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line"> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line">  <tt class="py-docstring">"""This class contains the logic to generate a report from the Reporting API</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line"><tt class="py-docstring">  web service.</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line"><tt class="py-docstring">  """</tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line"> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line">  <tt id="link-31" class="py-name" targets="Variable reporting.ReportRunner._AUTH_URL=reporting.ReportRunner-class.html#_AUTH_URL"><a title="reporting.ReportRunner._AUTH_URL" class="py-name" href="#" onclick="return doclink('link-31', '_AUTH_URL', 'link-31');">_AUTH_URL</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'https://www.google.com/accounts/ClientLogin'</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line">  <tt id="link-32" class="py-name" targets="Variable reporting.ReportRunner._REPORTING_URL=reporting.ReportRunner-class.html#_REPORTING_URL"><a title="reporting.ReportRunner._REPORTING_URL" class="py-name" href="#" onclick="return doclink('link-32', '_REPORTING_URL', 'link-32');">_REPORTING_URL</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'https://www.google.com'</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line">                    <tt class="py-string">'/hosted/services/v1.0/reports/ReportingData'</tt><tt class="py-op">)</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt>  <tt class="py-line"> </tt>
<a name="ReportRunner.__init__"></a><div id="ReportRunner.__init__-def"><a name="L171"></a><tt class="py-lineno">171</tt> <a class="py-toggle" href="#" id="ReportRunner.__init__-toggle" onclick="return toggle('ReportRunner.__init__');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportRunner-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportRunner.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportRunner.__init__-expanded"><a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line">    <tt class="py-docstring">"""Construct an instance of the report runner."""</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line"> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">admin_email</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">admin_password</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="uprgae.domain" class="py-name" href="#" onclick="return doclink('link-33', 'domain', 'link-1');">domain</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line"> </tt>
<a name="ReportRunner.GetAdminEmailDomain"></a><div id="ReportRunner.GetAdminEmailDomain-def"><a name="L179"></a><tt class="py-lineno">179</tt> <a class="py-toggle" href="#" id="ReportRunner.GetAdminEmailDomain-toggle" onclick="return toggle('ReportRunner.GetAdminEmailDomain');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportRunner-class.html#GetAdminEmailDomain">GetAdminEmailDomain</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportRunner.GetAdminEmailDomain-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportRunner.GetAdminEmailDomain-expanded"><a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line">    <tt class="py-docstring">"""Get administrator email adress domain.</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line"><tt class="py-docstring">    Returns:</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line"><tt class="py-docstring">      The domain portion of the administrator email address.</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line"><tt class="py-docstring">      e.g. For admin@example.com returns example.com</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">admin_email</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line">      <tt class="py-name">at_index</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">admin_email</tt><tt class="py-op">.</tt><tt class="py-name">rfind</tt><tt class="py-op">(</tt><tt class="py-string">'@'</tt><tt class="py-op">)</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">at_index</tt> <tt class="py-op">&gt;=</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">admin_email</tt><tt class="py-op">[</tt><tt class="py-name">at_index</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line"> </tt>
<a name="ReportRunner.GetLatestReportDate"></a><div id="ReportRunner.GetLatestReportDate-def"><a name="L192"></a><tt class="py-lineno">192</tt> <a class="py-toggle" href="#" id="ReportRunner.GetLatestReportDate-toggle" onclick="return toggle('ReportRunner.GetLatestReportDate');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportRunner-class.html#GetLatestReportDate">GetLatestReportDate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportRunner.GetLatestReportDate-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportRunner.GetLatestReportDate-expanded"><a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line">    <tt class="py-docstring">"""Get the date of the latest available report.</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line"><tt class="py-docstring">    Reports for the current date are available after 12:00 PST8PDT the following</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line"><tt class="py-docstring">    day.  We calculate and return the date of the latest available report based</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line"><tt class="py-docstring">    on the current time.  The PyTZ library can be used to calculate this more</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt>  <tt class="py-line"><tt class="py-docstring">    accurately, however since it is not part of a standard python installation</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line"><tt class="py-docstring">    we use -0800 as an approximation for the PST8PDT timezone.</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line"><tt class="py-docstring">    Returns:</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line"><tt class="py-docstring">      Latest report date.</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line">    <tt class="py-name">_HOURS</tt> <tt class="py-op">=</tt> <tt class="py-number">60</tt><tt class="py-op">*</tt><tt class="py-number">60</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line">    <tt class="py-name">_DAYS</tt> <tt class="py-op">=</tt> <tt class="py-number">24</tt><tt class="py-op">*</tt><tt class="py-name">_HOURS</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line">    <tt class="py-name">now</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line">    <tt class="py-name">pst_time</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">gmtime</tt><tt class="py-op">(</tt><tt class="py-name">now</tt> <tt class="py-op">-</tt> <tt class="py-number">8</tt> <tt class="py-op">*</tt> <tt class="py-name">_HOURS</tt><tt class="py-op">)</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">pst_time</tt><tt class="py-op">[</tt><tt class="py-number">3</tt><tt class="py-op">]</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">12</tt><tt class="py-op">:</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line">      <tt class="py-name">latest</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">gmtime</tt><tt class="py-op">(</tt><tt class="py-name">now</tt> <tt class="py-op">-</tt> <tt class="py-number">8</tt> <tt class="py-op">*</tt> <tt class="py-name">_HOURS</tt> <tt class="py-op">-</tt> <tt class="py-number">2</tt> <tt class="py-op">*</tt> <tt class="py-name">_DAYS</tt><tt class="py-op">)</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line">    <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line">      <tt class="py-name">latest</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">gmtime</tt><tt class="py-op">(</tt><tt class="py-name">now</tt> <tt class="py-op">-</tt> <tt class="py-number">8</tt> <tt class="py-op">*</tt> <tt class="py-name">_HOURS</tt> <tt class="py-op">-</tt> <tt class="py-number">1</tt> <tt class="py-op">*</tt> <tt class="py-name">_DAYS</tt><tt class="py-op">)</tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-string">'%04i-%02i-%02i'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">latest</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">latest</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">latest</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div><a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line">     </tt>
<a name="ReportRunner.__PostUrl"></a><div id="ReportRunner.__PostUrl-def"><a name="L214"></a><tt class="py-lineno">214</tt> <a class="py-toggle" href="#" id="ReportRunner.__PostUrl-toggle" onclick="return toggle('ReportRunner.__PostUrl');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportRunner-class.html#__PostUrl">__PostUrl</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">,</tt><tt class="py-param">gzip</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt>     </tt>
</div><a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line">  <tt class="py-comment">#def __PostUrl(self, url, data):</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-docstring">"""Post data to a URL.</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line"><tt class="py-docstring">    Args:</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line"><tt class="py-docstring">      url: URL to post to.</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line"><tt class="py-docstring">      data: data to post</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt>  <tt class="py-line"><tt class="py-docstring">    Raises:</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line"><tt class="py-docstring">      ConnectionError: When a connection error occurs or an HTTP response</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line"><tt class="py-docstring">        error code is returned.</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line"><tt class="py-comment">#edwood.ocasio: Compression request, future use?</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line"><tt class="py-comment"></tt>                 </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">gzip</tt> <tt class="py-op">==</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt>  <tt class="py-line">                        <tt class="py-keyword">print</tt> <tt class="py-string">"Compressed response"</tt> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line">                         </tt>
<a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line">                        <tt class="py-name">request</tt><tt class="py-op">.</tt><tt class="py-name">add_header</tt><tt class="py-op">(</tt><tt class="py-string">'Accept-encoding'</tt><tt class="py-op">,</tt> <tt class="py-string">'gzip'</tt><tt class="py-op">)</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt>  <tt class="py-line">                        <tt class="py-name">request</tt><tt class="py-op">.</tt><tt class="py-name">add_header</tt><tt class="py-op">(</tt><tt class="py-string">'User-Agent'</tt><tt class="py-op">,</tt> <tt class="py-string">'gzip'</tt><tt class="py-op">)</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line">                        <tt class="py-name">request</tt><tt class="py-op">=</tt><tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">)</tt>                     </tt>
<a name="L235"></a><tt class="py-lineno">235</tt>  <tt class="py-line">                        <tt class="py-comment">#~ opener = urllib2.build_opener()</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line"><tt class="py-comment"></tt>                        <tt class="py-comment">#~ urllib2.install_opener(opener)</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line"><tt class="py-comment"></tt>                        <tt class="py-keyword">return</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">urlopen</tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line">                         </tt>
<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line">                <tt class="py-comment"># anirudh example found in</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line"><tt class="py-comment"></tt>                <tt class="py-comment"># http://groups.google.com/group/google-apps-apis/browse_thread/thread/aa469bc03268d851#</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line"><tt class="py-comment"></tt>                        <tt class="py-comment">#~ headers = { 'User-Agent': 'gzip', 'Accept-Encoding': 'gzip' }</tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line"><tt class="py-comment"></tt>                <tt class="py-comment">#~ req = urllib2.Request(url, data, headers)</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line"><tt class="py-comment"></tt>                <tt class="py-comment">#~ return urllib2.urlopen(req).read() </tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt>  <tt class="py-line"><tt class="py-comment"></tt>                <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line">                        <tt class="py-keyword">return</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">urlopen</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-name">data</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line"> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line"><tt class="py-comment">#######################################################################</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line"><tt class="py-comment"></tt>                 </tt>
<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line">                         </tt>
<a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">HTTPError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line">      <tt class="py-keyword">raise</tt> <tt id="link-34" class="py-name" targets="Class reporting.ConnectionError=reporting.ConnectionError-class.html"><a title="reporting.ConnectionError" class="py-name" href="#" onclick="return doclink('link-34', 'ConnectionError', 'link-34');">ConnectionError</a></tt><tt class="py-op">(</tt><tt id="link-35" class="py-name" targets="Class reporting.ReportRunner=reporting.ReportRunner-class.html"><a title="reporting.ReportRunner" class="py-name" href="#" onclick="return doclink('link-35', 'ReportRunner', 'link-35');">ReportRunner</a></tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="reporting.ReportRunner._AUTH_URL" class="py-name" href="#" onclick="return doclink('link-36', '_AUTH_URL', 'link-31');">_AUTH_URL</a></tt><tt class="py-op">,</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line">                            <tt class="py-string">'HTTP Response Code: %i'</tt> <tt class="py-op">%</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">code</tt><tt class="py-op">)</tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">URLError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line">      <tt class="py-keyword">raise</tt> <tt id="link-37" class="py-name"><a title="reporting.ConnectionError" class="py-name" href="#" onclick="return doclink('link-37', 'ConnectionError', 'link-34');">ConnectionError</a></tt><tt class="py-op">(</tt><tt id="link-38" class="py-name"><a title="reporting.ReportRunner" class="py-name" href="#" onclick="return doclink('link-38', 'ReportRunner', 'link-35');">ReportRunner</a></tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="reporting.ReportRunner._AUTH_URL" class="py-name" href="#" onclick="return doclink('link-39', '_AUTH_URL', 'link-31');">_AUTH_URL</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt><tt class="py-op">)</tt> </tt>
</div><a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line"> </tt>
<a name="ReportRunner.Login"></a><div id="ReportRunner.Login-def"><a name="L256"></a><tt class="py-lineno">256</tt> <a class="py-toggle" href="#" id="ReportRunner.Login-toggle" onclick="return toggle('ReportRunner.Login');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportRunner-class.html#Login">Login</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportRunner.Login-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportRunner.Login-expanded"><a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line">    <tt class="py-docstring">"""Get an authorization token from the Auth URL web service.</tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line"><tt class="py-docstring">    This authorization token is cached in the ReportRunner instance.  If a new</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line"><tt class="py-docstring">    token is needed, for example if the token is 24 hours old, then call this</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line"><tt class="py-docstring">    method again to get a new token.</tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line"><tt class="py-docstring">    Raises:</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line"><tt class="py-docstring">      ConnectionError: When a connection error occurs and in particular</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt>  <tt class="py-line"><tt class="py-docstring">        when the credentials are incorrect.</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line"><tt class="py-docstring">      LoginError: When authentication service does not return a SID token.</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt>  <tt class="py-line">    <tt class="py-name">auth_request</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-op">{</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line">        <tt class="py-string">'accountType'</tt><tt class="py-op">:</tt> <tt class="py-string">'HOSTED'</tt><tt class="py-op">,</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line">        <tt class="py-string">'Email'</tt><tt class="py-op">:</tt>       <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">admin_email</tt><tt class="py-op">,</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line">        <tt class="py-string">'Passwd'</tt><tt class="py-op">:</tt>      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">admin_password</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line">    <tt class="py-name">auth_response</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name" targets="Method reporting.ReportRunner.__PostUrl()=reporting.ReportRunner-class.html#__PostUrl"><a title="reporting.ReportRunner.__PostUrl" class="py-name" href="#" onclick="return doclink('link-40', '__PostUrl', 'link-40');">__PostUrl</a></tt><tt class="py-op">(</tt><tt id="link-41" class="py-name"><a title="reporting.ReportRunner" class="py-name" href="#" onclick="return doclink('link-41', 'ReportRunner', 'link-35');">ReportRunner</a></tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="reporting.ReportRunner._AUTH_URL" class="py-name" href="#" onclick="return doclink('link-42', '_AUTH_URL', 'link-31');">_AUTH_URL</a></tt><tt class="py-op">,</tt> <tt class="py-name">auth_request</tt><tt class="py-op">)</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">auth_response</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line">                <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'='</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-op">==</tt> <tt class="py-string">'SID'</tt><tt class="py-op">:</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line">                        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line">                        <tt class="py-keyword">return</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line">                 </tt>
<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt id="link-43" class="py-name" targets="Class reporting.LoginError=reporting.LoginError-class.html"><a title="reporting.LoginError" class="py-name" href="#" onclick="return doclink('link-43', 'LoginError', 'link-43');">LoginError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Unable to get SID token from '</tt> <tt class="py-op">+</tt> <tt id="link-44" class="py-name"><a title="reporting.ReportRunner" class="py-name" href="#" onclick="return doclink('link-44', 'ReportRunner', 'link-35');">ReportRunner</a></tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="reporting.ReportRunner._AUTH_URL" class="py-name" href="#" onclick="return doclink('link-45', '_AUTH_URL', 'link-31');">_AUTH_URL</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line"> </tt>
<a name="ReportRunner.GetReportData"></a><div id="ReportRunner.GetReportData-def"><a name="L282"></a><tt class="py-lineno">282</tt> <a class="py-toggle" href="#" id="ReportRunner.GetReportData-toggle" onclick="return toggle('ReportRunner.GetReportData');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportRunner-class.html#GetReportData">GetReportData</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">report_request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportRunner.GetReportData-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportRunner.GetReportData-expanded"><a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line">    <tt class="py-docstring">"""Get the report data response from the Reporting API web service.</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line"><tt class="py-docstring">    Args:</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line"><tt class="py-docstring">      report_request: Reporting API request.</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line"><tt class="py-docstring">    Returns:</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line"><tt class="py-docstring">      Report data response as a string.</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line">     </tt>
<a name="L292"></a><tt class="py-lineno">292</tt>  <tt class="py-line">    <tt class="py-name">report_response</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name"><a title="reporting.ReportRunner.__PostUrl" class="py-name" href="#" onclick="return doclink('link-46', '__PostUrl', 'link-40');">__PostUrl</a></tt><tt class="py-op">(</tt><tt id="link-47" class="py-name"><a title="reporting.ReportRunner" class="py-name" href="#" onclick="return doclink('link-47', 'ReportRunner', 'link-35');">ReportRunner</a></tt><tt class="py-op">.</tt><tt id="link-48" class="py-name"><a title="reporting.ReportRunner._REPORTING_URL" class="py-name" href="#" onclick="return doclink('link-48', '_REPORTING_URL', 'link-32');">_REPORTING_URL</a></tt><tt class="py-op">,</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt>  <tt class="py-line">                                     <tt class="py-name">report_request</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name" targets="Method reporting.ReportRequest.ToXml()=reporting.ReportRequest-class.html#ToXml"><a title="reporting.ReportRequest.ToXml" class="py-name" href="#" onclick="return doclink('link-49', 'ToXml', 'link-49');">ToXml</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line">     </tt>
<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">report_response</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">report_response</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'&lt;?xml'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line">      <tt class="py-name">report_error</tt> <tt class="py-op">=</tt> <tt id="link-50" class="py-name"><a title="reporting.ReportError" class="py-name" href="#" onclick="return doclink('link-50', 'ReportError', 'link-12');">ReportError</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line">      <tt class="py-name">report_error</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name" targets="Method reporting.ReportError.FromXml()=reporting.ReportError-class.html#FromXml"><a title="reporting.ReportError.FromXml" class="py-name" href="#" onclick="return doclink('link-51', 'FromXml', 'link-51');">FromXml</a></tt><tt class="py-op">(</tt><tt class="py-name">report_response</tt><tt class="py-op">)</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line">      <tt class="py-keyword">raise</tt> <tt class="py-name">report_error</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">report_response</tt> </tt>
</div><a name="L300"></a><tt class="py-lineno">300</tt>  <tt class="py-line"> </tt>
<a name="ReportRunner.WriteReport"></a><div id="ReportRunner.WriteReport-def"><a name="L301"></a><tt class="py-lineno">301</tt> <a class="py-toggle" href="#" id="ReportRunner.WriteReport-toggle" onclick="return toggle('ReportRunner.WriteReport');">-</a><tt class="py-line">  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportRunner-class.html#WriteReport">WriteReport</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">response</tt><tt class="py-op">,</tt> <tt class="py-param">out_file_name</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportRunner.WriteReport-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportRunner.WriteReport-expanded"><a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line">    <tt class="py-docstring">"""Print the report response to either standard output or a file.</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line"><tt class="py-docstring">    Args:</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line"><tt class="py-docstring">      response: Report data response.</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line"><tt class="py-docstring">      out_file_name: Output file name (optional).</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">out_file_name</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line">      <tt class="py-keyword">print</tt> <tt class="py-name">response</tt><tt class="py-op">,</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt>  <tt class="py-line">    <tt class="py-keyword">else</tt><tt class="py-op">:</tt>     </tt>
<a name="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line">    <tt class="py-comment"># changed to append in case we are paging</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt>  <tt class="py-line"><tt class="py-comment"></tt>      <tt class="py-name">out_file</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">out_file_name</tt><tt class="py-op">,</tt> <tt class="py-string">'a'</tt><tt class="py-op">)</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line">      <tt class="py-keyword">print</tt> <tt class="py-op">&gt;&gt;</tt> <tt class="py-name">out_file</tt><tt class="py-op">,</tt> <tt class="py-name">response</tt><tt class="py-op">,</tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt>  <tt class="py-line">      <tt class="py-name">out_file</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L315"></a><tt class="py-lineno">315</tt>  <tt class="py-line">       </tt>
<a name="L316"></a><tt class="py-lineno">316</tt>  <tt class="py-line"><tt class="py-comment">#edwood.ocasio: added page_requested parameter to RunReport to facilitate paging</tt> </tt>
<a name="ReportRunner.RunReport"></a><div id="ReportRunner.RunReport-def"><a name="L317"></a><tt class="py-lineno">317</tt> <a class="py-toggle" href="#" id="ReportRunner.RunReport-toggle" onclick="return toggle('ReportRunner.RunReport');">-</a><tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting.ReportRunner-class.html#RunReport">RunReport</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">report_name</tt><tt class="py-op">,</tt> <tt class="py-param">report_date</tt><tt class="py-op">,</tt> <tt class="py-param">out_file_name</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt><tt class="py-param">page_requested</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReportRunner.RunReport-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ReportRunner.RunReport-expanded"><a name="L318"></a><tt class="py-lineno">318</tt>  <tt class="py-line">    <tt class="py-docstring">"""Run the named report for the given day and write to the output file.</tt> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt>  <tt class="py-line"><tt class="py-docstring">    Args:</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line"><tt class="py-docstring">      report_name: Name of the report to run.</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line"><tt class="py-docstring">      report_date: Run the report for this day.</tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt>  <tt class="py-line"><tt class="py-docstring">      out_file_name: Write the report data to this file (optional).</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name" targets="Method reporting.ReportRunner.Login()=reporting.ReportRunner-class.html#Login"><a title="reporting.ReportRunner.Login" class="py-name" href="#" onclick="return doclink('link-52', 'Login', 'link-52');">Login</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt>  <tt class="py-line">    <tt class="py-name">request</tt> <tt class="py-op">=</tt> <tt id="link-53" class="py-name"><a title="reporting.ReportRequest" class="py-name" href="#" onclick="return doclink('link-53', 'ReportRequest', 'link-2');">ReportRequest</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line">    <tt class="py-name">request</tt><tt class="py-op">.</tt><tt class="py-name">token</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="uprgae.domain" class="py-name" href="#" onclick="return doclink('link-54', 'domain', 'link-1');">domain</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt>  <tt class="py-line">      <tt class="py-name">request</tt><tt class="py-op">.</tt><tt id="link-55" class="py-name"><a title="uprgae.domain" class="py-name" href="#" onclick="return doclink('link-55', 'domain', 'link-1');">domain</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="uprgae.domain" class="py-name" href="#" onclick="return doclink('link-56', 'domain', 'link-1');">domain</a></tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line">    <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt>  <tt class="py-line">      <tt class="py-name">request</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="uprgae.domain" class="py-name" href="#" onclick="return doclink('link-57', 'domain', 'link-1');">domain</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-58" class="py-name" targets="Method reporting.ReportRunner.GetAdminEmailDomain()=reporting.ReportRunner-class.html#GetAdminEmailDomain"><a title="reporting.ReportRunner.GetAdminEmailDomain" class="py-name" href="#" onclick="return doclink('link-58', 'GetAdminEmailDomain', 'link-58');">GetAdminEmailDomain</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">report_date</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt>  <tt class="py-line">      <tt class="py-name">report_date</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name" targets="Method reporting.ReportRunner.GetLatestReportDate()=reporting.ReportRunner-class.html#GetLatestReportDate"><a title="reporting.ReportRunner.GetLatestReportDate" class="py-name" href="#" onclick="return doclink('link-59', 'GetLatestReportDate', 'link-59');">GetLatestReportDate</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt>  <tt class="py-line">    <tt class="py-name">request</tt><tt class="py-op">.</tt><tt class="py-name">report_name</tt> <tt class="py-op">=</tt> <tt class="py-name">report_name</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt>  <tt class="py-line">    <tt class="py-name">request</tt><tt class="py-op">.</tt><tt class="py-name">date</tt> <tt class="py-op">=</tt> <tt class="py-name">report_date</tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line"><tt class="py-comment">#edwood.ocasio: set new ReportReques.page attribute</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-name">request</tt><tt class="py-op">.</tt><tt class="py-name">page</tt><tt class="py-op">=</tt><tt class="py-name">page_requested</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt>  <tt class="py-line"><tt class="py-comment">#####################################3</tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-name">response</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name" targets="Method reporting.ReportRunner.GetReportData()=reporting.ReportRunner-class.html#GetReportData"><a title="reporting.ReportRunner.GetReportData" class="py-name" href="#" onclick="return doclink('link-60', 'GetReportData', 'link-60');">GetReportData</a></tt><tt class="py-op">(</tt><tt class="py-name">request</tt><tt class="py-op">)</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line"> </tt>
<a name="L342"></a><tt class="py-lineno">342</tt>  <tt class="py-line">    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name" targets="Method reporting.ReportRunner.WriteReport()=reporting.ReportRunner-class.html#WriteReport"><a title="reporting.ReportRunner.WriteReport" class="py-name" href="#" onclick="return doclink('link-61', 'WriteReport', 'link-61');">WriteReport</a></tt><tt class="py-op">(</tt><tt class="py-name">response</tt><tt class="py-op">,</tt> <tt class="py-name">out_file_name</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L343"></a><tt class="py-lineno">343</tt>  <tt class="py-line"> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt>  <tt class="py-line"> </tt>
<a name="_Usage"></a><div id="_Usage-def"><a name="L345"></a><tt class="py-lineno">345</tt> <a class="py-toggle" href="#" id="_Usage-toggle" onclick="return toggle('_Usage');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="reporting-module.html#_Usage">_Usage</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_Usage-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_Usage-expanded"><a name="L346"></a><tt class="py-lineno">346</tt>  <tt class="py-line">  <tt class="py-name">USAGE</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'_Usage: reporting.py --email=&lt;email&gt; --password=&lt;password&gt; '</tt> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt>  <tt class="py-line">           <tt class="py-string">'[ --domain=&lt;domain&gt; ] --report=&lt;report name&gt; '</tt> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt>  <tt class="py-line">           <tt class="py-string">'[ --date=&lt;YYYY-MM-DD&gt; ] [ --out=&lt;file name&gt; ]'</tt><tt class="py-op">)</tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt>  <tt class="py-line">  <tt class="py-keyword">print</tt> <tt class="py-name">USAGE</tt> </tt>
</div><a name="L350"></a><tt class="py-lineno">350</tt>  <tt class="py-line"> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt>  <tt class="py-line"> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt>  <tt class="py-line"><tt class="py-comment">#~ def main():</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ """Construct report request from command-line arguments and run the report.</tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ """</tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt>  <tt class="py-line"><tt class="py-comment"></tt>        <tt class="py-comment">#~ try:</tt> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt>  <tt class="py-line"><tt class="py-comment"></tt>                <tt class="py-comment">#~ (opts, args) = getopt.getopt(sys.argv[1:], '', ['email=', 'password=','domain=', 'report=', 'date=', 'out='])</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt>  <tt class="py-line"><tt class="py-comment"></tt>        <tt class="py-comment">#~ except getopt.GetoptError: _Usage()</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment">#~ sys.exit(2)</tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ opts = dict(opts)</tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ report_runner = ReportRunner()</tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ report_runner.admin_email = opts.get('--email')</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ report_runner.admin_password = opts.get('--password')</tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ report_runner.domain = opts.get('--domain')</tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ report_name = opts.get('--report')</tt> </tt>
<a name="L365"></a><tt class="py-lineno">365</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ report_date = opts.get('--date')</tt> </tt>
<a name="L366"></a><tt class="py-lineno">366</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ out_file_name = opts.get('--out')</tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ if (not report_runner.admin_email or not report_runner.admin_password or</tt> </tt>
<a name="L368"></a><tt class="py-lineno">368</tt>  <tt class="py-line"><tt class="py-comment"></tt>      <tt class="py-comment">#~ not report_name or (report_date is not None</tt> </tt>
<a name="L369"></a><tt class="py-lineno">369</tt>  <tt class="py-line"><tt class="py-comment"></tt>      <tt class="py-comment">#~ and not re.compile('\d{4}-\d{2}-\d{2}').match(report_date))):</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment">#~ _Usage()</tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment">#~ sys.exit(2)</tt> </tt>
<a name="L372"></a><tt class="py-lineno">372</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment">#~ </tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt>  <tt class="py-line"><tt class="py-comment"></tt>        <tt class="py-comment">#~ report_runner.RunReport(report_name, report_date, out_file_name)</tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#~ </tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#~ </tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#~ if __name__ == '__main__':</tt> </tt>
<a name="L377"></a><tt class="py-lineno">377</tt>  <tt class="py-line"><tt class="py-comment"></tt>  <tt class="py-comment">#~ main()</tt> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/uprgae-console/">UPR-GAE console</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Sep  1 16:17:53 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
